Home Explore Help
Register Sign In
J1X
/
huginn
Watch 2
Star 0
Fork 0

Browse Source
Merge pull request #1334 from dsander/documentation-updates

Documentation updates

Dominik Sander 9 years ago
parent
1faf950273 083e0e18ad
commit
e36b01fd2e
6 changed files with 33 additions and 19 deletions
Show Diff Stats
  1. 17 9
      doc/manual/installation.md
  2. 8 2
      docker/multi-process/README.md
  3. 2 2
      docker/multi-process/docker-compose.yml
  4. 2 2
      docker/single-process/develop.yml
  5. 2 2
      docker/single-process/docker-compose.yml
  6. 2 2
      docker/single-process/postgresql.yml

+ 17 - 9
doc/manual/installation.md
View File 

@@ -73,7 +73,7 @@ Download Ruby and compile it:
73 73
74 74 
 Install the bundler and foreman gems:
75 75
76 
-    sudo gem install bundler foreman --no-ri --no-rdoc
76 
+    sudo gem install rake bundler foreman --no-ri --no-rdoc
77 77
78 78 
 ## 3. System Users
79 79 
 
@@ -218,14 +218,12 @@ Change the Unicorn config if needed, the [requirements.md](./requirements.md#uni
218 218 
     # Migrate to the latest version
219 219 
     sudo -u huginn -H bundle exec rake db:migrate RAILS_ENV=production
220 220
221 
-    # Create admin user and example agents
222 
-    sudo -u huginn -H bundle exec rake db:seed RAILS_ENV=production
221 
+    # Create admin user and example agents using the default admin/password login
222 
+    sudo -u huginn -H bundle exec rake db:seed RAILS_ENV=production SEED_USERNAME=admin SEED_PASSWORD=password
223 223
224 224 
 When done you see `See the Huginn Wiki for more Agent examples!  https://github.com/cantino/huginn/wiki`
225 225
226 
-**Note:** This will create an initial user, you can set the username and password by supplying it in environmental variables `SEED_USERNAME` and `SEED_PASSWORD` as seen below. If you don't set the password (and it is set to the default one) please wait with exposing Huginn to the public internet until the installation is done and you've logged into the server and changed your password.
227 
-
228 
-    sudo -u huginn -H bundle exec rake db:seed RAILS_ENV=production SEED_USERNAME=admin SEED_PASSWORD=yourpassword
226 
+**Note:** This will create an initial user, you can change the username and password by supplying it in environmental variables `SEED_USERNAME` and `SEED_PASSWORD` as seen above. If you don't change the password (and it is set to the default one) please wait with exposing Huginn to the public internet until the installation is done and you've logged into the server and changed your password.
229 227
230 228 
 ### Compile Assets
231 229 
 
@@ -235,10 +233,20 @@ When done you see `See the Huginn Wiki for more Agent examples!  https://github.
235 233
236 234 
 Huginn uses [foreman](http://ddollar.github.io/foreman/) to generate the init scripts based on a `Procfile`
237 235
238 
-Edit the `Procfile` and choose one of the suggested versions for production
236 
+Edit the [`Procfile`](https://github.com/cantino/huginn/blob/master/Procfile) and choose one of the suggested versions for production
239 237
240 238 
     sudo -u huginn -H editor Procfile
241 239
240 
+Comment out (disable) [these two lines](https://github.com/cantino/huginn/blob/master/Procfile#L6-L7)
241 
+
242 
+    web: bundle exec rails server -p ${PORT-3000} -b ${IP-0.0.0.0}
243 
+    jobs: bundle exec rails runner bin/threaded.rb
244 
+
245 
+Enable (remove the comment) [from these lines](https://github.com/cantino/huginn/blob/master/Procfile#L24-L25) or [those](https://github.com/cantino/huginn/blob/master/Procfile#L28-L31)
246 
+
247 
+    # web: bundle exec unicorn -c config/unicorn.rb
248 
+    # jobs: bundle exec rails runner bin/threaded.rb
249 
+
242 250 
 Export the init scripts:
243 251
244 252 
     sudo bundle exec rake production:export
 
@@ -299,8 +307,8 @@ You should receive `syntax is okay` and `test is successful` messages. If you re
299 307
300 308 
 Visit YOUR_SERVER in your web browser for your first Huginn login. The setup has created a default admin account for you. You can use it to log in:
301 309
302 
-    admin
303 
-    password
310 
+    admin (or your SEED_USERNAME)
311 
+    password (or your SEED_PASSWORD)
304 312
305 313
306 314 
 **Enjoy!** :sparkles: :star: :fireworks:

+ 8 - 2
docker/multi-process/README.md
View File 

@@ -23,7 +23,9 @@ and
23 23 
 Its recommended to use an image that allows you to create a database via environmental variables at docker run, like `paintedfox / postgresql` or `centurylink / mysql`, so the db is populated when this script runs.
24 24
25 25 
 If you do not link a database container, a built-in mysql database will be started.
26 
-There is an exported docker volume of /var/lib/mysql to allow persistence of that mysql database.
26 
+There is an exported docker volume of `/var/lib/mysql` to allow persistence of that mysql database.
27 
+
28 
+__NOTE:__ If you do not export the volme, or use a linked database container, you cannot update Huginn without losing your data.
27 29
28 30 
 Additionally, the database variables may be overridden from the above as per the standard Huginn documentation:
29 31 
 
@@ -45,10 +47,14 @@ The CMD launches Huginn via the scripts/init script. This may become the ENTRYPO
45 47
46 48 
 ## Usage
47 49
48 
-Simple stand-alone usage:
50 
+Simple stand-alone usage (use only for testing/evaluation as it can not be updated without losing data):
49 51
50 52 
     docker run -it -p 3000:3000 cantino/huginn
51 53
54 
+Use a volume to export the data of the internal mysql server:
55 
+
56 
+    docker run -it -p 3000:3000 -v /home/huginn/mysql-data:/var/lib/mysql cantino/huginn
57 
+
52 58 
 To link to another mysql container, for example:
53 59
54 60 
     docker run --rm --name huginn_mysql \

+ 2 - 2
docker/multi-process/docker-compose.yml
View File 

@@ -1,9 +1,9 @@
1 1 
 mysqldata:
2 
-  image: mysql
2 
+  image: mysql:5.7
3 3 
   command: /bin/true
4 4
5 5 
 mysql:
6 
-  image: mysql
6 
+  image: mysql:5.7
7 7 
   volumes_from:
8 8 
     - mysqldata
9 9 
   environment:

+ 2 - 2
docker/single-process/develop.yml
View File 

@@ -1,9 +1,9 @@
1 1 
 mysqldata:
2 
-  image: mysql
2 
+  image: mysql:5.7
3 3 
   command: /bin/true
4 4
5 5 
 mysql:
6 
-  image: mysql
6 
+  image: mysql:5.7
7 7 
   volumes_from:
8 8 
     - mysqldata
9 9 
   environment:

+ 2 - 2
docker/single-process/docker-compose.yml
View File 

@@ -1,9 +1,9 @@
1 1 
 mysqldata:
2 
-  image: mysql
2 
+  image: mysql:5.7
3 3 
   command: /bin/true
4 4
5 5 
 mysql:
6 
-  image: mysql
6 
+  image: mysql:5.7
7 7 
   volumes_from:
8 8 
     - mysqldata
9 9 
   environment:

+ 2 - 2
docker/single-process/postgresql.yml
View File 

@@ -1,9 +1,9 @@
1 1 
 postgresdata:
2 
-  image: postgres
2 
+  image: postgres:9.5
3 3 
   command: /bin/true
4 4
5 5 
 postgres:
6 
-  image: postgres
6 
+  image: postgres:9.5
7 7 
   volumes_from:
8 8 
     - postgresdata
9 9 
   environment: